Update Policy

Route

/v2/policies/{id}

Description

Update an existing policy with the provided configuration. The 'If-Match' header with the resource version can be optionally specified for concurrency control.

Method

PUT

Inputs

Parameter	Type	Required	Description
id	string	Yes	Unique identifier of the policy to update
type	string	Yes	Policy type (data_protection, content_inspection)
name	string	Yes	Human-readable name for the policy
description	string	No	Detailed description of the policy's purpose
severity	string	Yes	Severity level (informational, low, medium, high, critical)
selection_type	string	Yes	How datasets are selected (dataset, sensitivity)
dataset_ids	array[string]	No	List of dataset IDs (when selection_type is dataset)
dataset_sensitivities	array[integer]	No	List of sensitivity levels (when selection_type is sensitivity)
rule	object	Yes	Rule configuration for policy enforcement actions
exclude_origin	boolean	No	Whether to exclude origin location in policy evaluation
backfills_enabled	boolean	No	Whether historical data backfills are enabled

Headers

Header	Type	Required	Description
If-Match	string	No	Resource version for concurrency control

Request Body

{
  "type": "data_protection",
  "name": "Updated Policy Name",
  "description": "Updated policy description",
  "severity": "critical",
  "selection_type": "sensitivity",
  "dataset_sensitivities": [3, 4, 5],
  "rule": {
    "status": "risky",
    "create_incident": true,
    "record_screenshots": false,
    "inspect_content": true,
    "realtime_response_config": {
      "incident_action": "block"
    }
  },
  "exclude_origin": false,
  "backfills_enabled": true
}

Output

Field	Type	Description
type	string	Always "policies"
size	integer	Number of policies returned (always 1)
resources	array[Policy]	Array containing the updated policy
errors	array[Error]	Any errors encountered

Rate Limit

• 60 requests per minute per API key
• 5 concurrent requests per endpoint

Example Response

{
  "type": "policies",
  "size": 1,
  "resources": [
    {
      "id": "policy-123",
      "version": "v1.2.4",
      "type": "data_protection",
      "name": "Updated Policy Name",
      "description": "Updated policy description",
      "severity": "critical",
      "disabled": false,
      "selection_type": "sensitivity",
      "dataset_sensitivities": [3, 4, 5],
      "created_at": "2024-01-15T10:30:00Z",
      "last_modified": "2024-01-25T16:45:00Z"
    }
  ],
  "errors": []
}